Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Update runnable-endpoint docs to use live example instead of image

Summary

Updated the runnable-endpoint.mdx documentation page to show an actual working example of the <RunnableEndpoint> component instead of a static image. The new format matches the pattern used in endpoint-request-snippet.mdx, showing both the markdown code and the rendered component.

Changes:

  • Removed <Tabs> component with image
  • Added <CodeBlock> showing the markdown syntax
  • Added live <RunnableEndpoint endpoint="POST /snippets" /> component below the code block

Review & Testing Checklist for Human

  • Preview the documentation page - Verify the RunnableEndpoint component renders correctly on the page (not just the code block)
  • Test the interactive component - Ensure the POST /snippets endpoint works with the RunnableEndpoint component and can make actual requests
  • Check the preview deployment - Verify the page looks correct in the preview deployment and matches the design intent

Notes


Link to Devin run: https://app.devin.ai/sessions/916c02c6fede4dffb4cb27968d8f9a73
Requested by: [email protected] (@Ryan-Amirthan)

- Replace Tabs component with actual RunnableEndpoint example
- Follow same format as endpoint-request-snippet documentation
- Use POST /snippets endpoint as the example
- Show both the markdown code and rendered component

Co-Authored-By: [email protected] <[email protected]>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants